home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 24 / AMIGAplus Sonderheft 24 (2000)(Falke)(DE)[!].iso / Tools / KeyStick / KeyStick.doc < prev    next >
Text File  |  1999-11-06  |  6KB  |  139 lines
  1.  
  2.  
  3.                           ___________________________
  4.                          |                           |
  5.                          |      K E Y S T I C K      |
  6.                          |                           |
  7.                          |        Version 2.1        |
  8.                          |                           |
  9.                          |   © 1996 by Paul Shandi   |
  10.                          |___________________________|
  11.  
  12.  
  13.  
  14.  --<  INTRODUCTION  >-------------------------------------------------------
  15.  
  16.  This program lets you use a standard one-button joystick with keyboard
  17.  controlled games.  That is, each of the 8 directions can be assigned a key,
  18.  as can the fire button.  I wrote this program because I had a tetris game
  19.  that was played by keyboard only, and I wanted to use a joystick.  :)
  20.  
  21.  
  22.  
  23.  --<  STARTING THE PROGRAM  >-----------------------------------------------
  24.  
  25.  First off, note that the program ONLY works with Workbench 2.04 or later!
  26.  If you're using Workbench 1.3 then the program will refuse to start.
  27.  
  28.  Also, the program ONLY works with a joystick in Port 1, ie. the one that
  29.  the mouse is not normally plugged into.  This could change in a future
  30.  release of the program, but it won't happen unless the demand is there,
  31.  so write to me!  :)
  32.  
  33.  Okay, there are 3 files associated with the program, and they are:
  34.  
  35.  KeyStick           -  The main program
  36.  KeyStick.doc       -  This documentation
  37.  KeyStick.doc.info  -  This documentation's icon
  38.  
  39.  Ideally, these should all stay in the same directory, although the more
  40.  experienced amongst you will do what you like with them!  Anyway, the
  41.  program MUST be run from the CLI only; there is no Workbench support.
  42.  
  43.  Running it from Workbench will cause it to crash, and possibly reboot your
  44.  system!  You have been warned, so make sure it's CLI only!  Why CLI and
  45.  not Workbench?  Because it's intended for use in scripts!  :)
  46.  
  47.  The program reads its joystick direction assignments from CLI arguments.
  48.  
  49.  These are:
  50.  
  51.  x=<pos>       The horizontal screen position of the window.   -1=Centred.
  52.  y=<pos>       The vertical screen position of the window.     -1=Centred.
  53.  af=<0|1>      Decides if constant firing occurs.              0=No, 1=Yes.
  54.  ad=<0|1>      Decides if constant direction movement occurs.  0=No, 1=Yes.
  55.  f=<keycode>   The key to emulate the fire button.
  56.  u=<keycode>   The key to emulate joystick up.
  57.  d=<keycode>   The key to emulate joystick down.
  58.  l=<keycode>   The key to emulate joystick left.
  59.  r=<keycode>   The key to emulate joystick right.
  60.  ul=<keycode>  The key to emulate joystick up and left.
  61.  ur=<keycode>  The key to emulate joystick up and right.
  62.  dl=<keycode>  The key to emulate joystick down and left.
  63.  dr=<keycode>  The key to emulate joystick down and right.
  64.  
  65.  In the above, <keycode> is an ASCII keycode for the key desired.  For
  66.  example, if you wanted the space bar to be the fire button, you would use:
  67.  
  68.  > keystick f=32  (the ASCII code for space is 32)
  69.  
  70.  If you enter no CLI arguments, the program defaults to no autofire, no
  71.  autodir, fire for space, and up/down/left/right for cursor keys.  The
  72.  diagonal directions (upleft/upright/downleft/downright) are not assigned.
  73.  
  74.  Don't worry if you don't know what ASCII codes are.  Why?  Well, at any
  75.  time while the program is running and its window is deactivated, just click
  76.  on it and the screen's title bar will display all the current ASCII values
  77.  for the joystick and the window's current screen positions.  Just jot these
  78.  values down for future use with the program if desired.
  79.  
  80.  You can change the assignments while the program is running simply by
  81.  clicking on the program's window and selecting a menu option.  If you
  82.  decide to change a key assignment, you will be asked to press the new key
  83.  for the selected joystick action.  The new key's ASCII code will be shown
  84.  in the screen's title bar as explained above.
  85.  
  86.  If pressing a key does not respond, then the key is NOT valid for use.
  87.  Such keys are shift, control, alt, etc.  You can only use keys which will
  88.  produce output in a CLI window.
  89.  
  90.  The program won't work with all games, because some games take over the
  91.  Amiga completely.  It SHOULD work with all Workbench games and any game
  92.  that is system-friendly (ie. uses standard Intuition screens etc).
  93.  
  94.  
  95.  
  96.  --<  COPYRIGHT AND DISTRIBUTION  >-----------------------------------------
  97.  
  98.  "KeyStick" is ShareWare.  This means anyone can spread it where they see
  99.  fit.  You may upload it to BBS's, submit it to PD libraries, give it to
  100.  your friends; whatever.  However, it is NOT a PD product; the author
  101.  retains all copyrights to it, as well as this documentation.
  102.  
  103.  COMMERCIAL NOTE: Although this program can be freely distributed, it may
  104.  NOT be distributed as part of a commercial package under ANY circumstances!
  105.  Doing so will get you issued with a lawsuit, so don't consider it.  If you
  106.  would like to have it as part of a commercial package, contact me first.
  107.  The single and ONLY exception to this commercial-related rule is when the
  108.  program is to be included in a (CD-ROM?) compilation of PD, ShareWare or
  109.  Freely Distributable software, such as the excellent Aminet CD collections.
  110.  
  111.  The program MUST be distributed with the following 3 files, of which NONE
  112.  may be altered or omitted:
  113.  
  114.  KeyStick           -  The main program
  115.  KeyStick.doc       -  This documentation
  116.  KeyStick.doc.info  -  This documentation's icon
  117.  
  118.  Registering this program costs $10 Australian dollars, in cash ONLY.  What
  119.  do you get if you register?  An improved version which reads in a text file
  120.  containing up to 20 different game assignments.  This means you can change
  121.  assignments from a new menu option whenever you change games, saving the
  122.  need to re-assign on the fly or quitting and re-running the program.  :)
  123.  
  124.  
  125.  
  126.  --<  CONTACTING THE AUTHOR  >----------------------------------------------
  127.  
  128.  You can contact me (Paul Shandi) via two methods:
  129.  
  130.  PO Box 1003, Dee Why, NSW, 2099, Australia
  131.  shandman@fl.net.au
  132.  
  133.  Please do so if you have any comments, corrections, additions, etc, about
  134.  the program.  Thanks, and enjoy the program!  :)
  135.  
  136.  =======================<  END OF DOCUMENTATION  >==========================
  137.  
  138.  
  139.